<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Class failed_step_checker</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Numeric.Odeint">
<link rel="up" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/max_step_checker.hpp&gt;">
<link rel="prev" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/max_step_checker.hpp&gt;">
<link rel="next" href="max_step_checker.html" title="Class max_step_checker">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../logo.jpg"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="max_step_checker.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.numeric.odeint.failed_step_checker"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class failed_step_checker</span></h2>
<p>boost::numeric::odeint::failed_step_checker — A class for performing overflow checks on the failed step count in step size adjustments. </p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html" title="Header &lt;boost/numeric/odeint/integrate/max_step_checker.hpp&gt;">boost/numeric/odeint/integrate/max_step_checker.hpp</a>&gt;

</span>
<span class="keyword">class</span> <a class="link" href="failed_step_checker.html" title="Class failed_step_checker">failed_step_checker</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">numeric</span><span class="special">::</span><span class="identifier">odeint</span><span class="special">::</span><span class="identifier">max_step_checker</span> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="failed_step_checker.html#boost.numeric.odeint.failed_step_checkerconstruct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="failed_step_checker.html#idm45749804530848-bb"><span class="identifier">failed_step_checker</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">500</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="failed_step_checker.html#idm45749804535344-bb">public member functions</a></span>
  <span class="keyword">void</span> <a class="link" href="failed_step_checker.html#idm45749804534784-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">void</span> <a class="link" href="failed_step_checker.html#idm45749804532912-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idm45491121199072"></a><h2>Description</h2>
<p>Used internally within the dense output stepper and integrate routines. </p>
<div class="refsect2">
<a name="idm45491121198400"></a><h3>
<a name="boost.numeric.odeint.failed_step_checkerconstruct-copy-destruct"></a><code class="computeroutput">failed_step_checker</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
<pre class="literallayout"><a name="idm45749804530848-bb"></a><span class="identifier">failed_step_checker</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">int</span> max_steps <span class="special">=</span> <span class="number">500</span><span class="special">)</span><span class="special">;</span></pre>Construct the <code class="computeroutput"><a class="link" href="failed_step_checker.html" title="Class failed_step_checker">failed_step_checker</a></code>. max_steps is the maximal number of iterations allowed before runtime_error is thrown. </li></ol></div>
</div>
<div class="refsect2">
<a name="idm45491121188272"></a><h3>
<a name="idm45749804535344-bb"></a><code class="computeroutput">failed_step_checker</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45749804534784-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span><span class="special">;</span></pre>Increases the counter and performs the iteration check. </li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idm45749804532912-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Resets the <code class="computeroutput"><a class="link" href="max_step_checker.html" title="Class max_step_checker">max_step_checker</a></code> by setting the internal counter to 0. </li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2009-2015 Karsten Ahnert and Mario Mulansky<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../header/boost/numeric/odeint/integrate/max_step_checker_hpp.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="max_step_checker.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
